package 多线程.AtomicInteger原理用法;
import java.util.function.IntUnaryOperator;
import java.util.function.IntBinaryOperator;
import sun.misc.Unsafe;

/**
 * 一个int数组，其中的元素可以自动更新。有关原子变量属性的描述，请参阅atomic包规范。
 */
public class AtomicIntegerArray implements java.io.Serializable {
    private static final long serialVersionUID = 2862133569453604235L;
    
	// 用于低级别、高效内存访问的 Unsafe 类
    private static final Unsafe unsafe = Unsafe.getUnsafe();
    // 数组元素的基本偏移量（由 Unsafe 使用）
    private static final int base = unsafe.arrayBaseOffset(int[].class);
    // 将索引转换为字节偏移的位移值（由 Unsafe 使用）
    private static final int shift;
    // 底层的 int 数组
    private final int[] array;

    /**
     * 根据数组索引比例初始化位移值
     */
    static {
        // scale为一个数组元素的大小，scale为二的幂
        int scale = unsafe.arrayIndexScale(int[].class);
        // 检查比例是否为二的幂
        if ((scale & (scale - 1)) != 0)
            throw new Error("data type scale not a power of two");
        // 根据比例计算位移值
        /* 
         比如scale为4，Integer.numberOfLeadingZeros(scale)表示scale前面有多少个0，
         int在JVM中有4个字节表示，即由32位表示4的二进制为00000000000000000000000000000100,
         Integer.numberOfLeadingZeros(scale)计算出来为29,即二进制的1前面有29个0，那么shift=31-29=2,
         表示二进制的1在第2号位上， 2^2 = 4
         */
        shift = 31 - Integer.numberOfLeadingZeros(scale);
    }

    // 检查并返回给定索引的字节偏移
    private long checkedByteOffset(int i) {
        if (i < 0 || i >= array.length)
            throw new IndexOutOfBoundsException("index " + i);
		// 使用 byteOffset 方法返回字节偏移
        return byteOffset(i);
    }

    // 计算给定索引的字节偏移
    private static long byteOffset(int i) {
        // 使用位移和基本值计算并返回字节偏移
        return ((long) i << shift) + base;
    }

    /**
     * 创建给定长度的新AtomicIntegerArray，初始所有元素为零。
     */
    public AtomicIntegerArray(int length) {
        array = new int[length];
    }

    /**
     * 创建一个新的AtomicIntegerArray，其长度与给定数组相同，并从给定数组复制所有元素。
     */
    public AtomicIntegerArray(int[] array) {
        // 最终字段保证的可见性
        this.array = array.clone();
    }

    /**
     * 返回数组的长度。
     */
    public final int length() {
        return array.length;
    }

    /**
     * 获取位置i的当前值。
     */
    public final int get(int i) {
        return getRaw(checkedByteOffset(i));
    }

    private int getRaw(long offset) {
        return unsafe.getIntVolatile(array, offset);
    }

    /**
     * 将位置i处的元素设置为给定值。
     */
    public final void set(int i, int newValue) {
        unsafe.putIntVolatile(array, checkedByteOffset(i), newValue);
    }

    /**
     * 最终将第i位置的元素设置为给定值。
     */
    public final void lazySet(int i, int newValue) {
        unsafe.putOrderedInt(array, checkedByteOffset(i), newValue);
    }

    /**
     * 自动将位置i处的元素设置为给定值并返回旧值。
     */
    public final int getAndSet(int i, int newValue) {
        return unsafe.getAndSetInt(array, checkedByteOffset(i), newValue);
    }

    /**
     * 如果当前值==期望值，则自动将位置i处的元素设置为给定的更新值。
     */
    public final boolean compareAndSet(int i, int expect, int update) {
        return compareAndSetRaw(checkedByteOffset(i), expect, update);
    }

    private boolean compareAndSetRaw(long offset, int expect, int update) {
        return unsafe.compareAndSwapInt(array, offset, expect, update);
    }

    /**
     * 如果当前值==期望值，则自动将位置i处的元素设置为给定的更新值。
     * 可能会错误地失败，并且不提供排序保证，因此很少作为compareAndSet的合适替代。
     */
    public final boolean weakCompareAndSet(int i, int expect, int update) {
        return compareAndSet(i, expect, update);
    }

    /**
     * 对索引i处的元素自动加1。
     */
    public final int getAndIncrement(int i) {
        return getAndAdd(i, 1);
    }

    /**
     * 对索引i处的元素自动减1。
     */
    public final int getAndDecrement(int i) {
        return getAndAdd(i, -1);
    }

    /**
     * 自动将给定值添加到索引i处的元素。
     */
    public final int getAndAdd(int i, int delta) {
        return unsafe.getAndAddInt(array, checkedByteOffset(i), delta);
    }

    /**
     * 对索引i处的元素自动加1。
     */
    public final int incrementAndGet(int i) {
        return getAndAdd(i, 1) + 1;
    }

    /**
     * 自动地将索引i处的元素减1。
     */
    public final int decrementAndGet(int i) {
        return getAndAdd(i, -1) - 1;
    }

    /**
     * 自动将给定值添加到索引i处的元素。
     */
    public final int addAndGet(int i, int delta) {
        return getAndAdd(i, delta) + delta;
    }


    /**
     * 使用应用给定函数的结果自动更新索引i处的元素，返回前一个值。
     * 该函数应该没有副作用，因为当尝试更新由于线程之间的争用而失败时，可以重新应用它。
     */
    public final int getAndUpdate(int i, IntUnaryOperator updateFunction) {
        long offset = checkedByteOffset(i);
        int prev, next;
        do {
            prev = getRaw(offset);
            next = updateFunction.applyAsInt(prev);
        } while (!compareAndSetRaw(offset, prev, next));
        return prev;
    }

    /**
     * 使用应用给定函数的结果自动更新索引i处的元素，并返回更新后的值。
     * 该函数应该没有副作用，因为当尝试更新由于线程之间的争用而失败时，可以重新应用它。
     */
    public final int updateAndGet(int i, IntUnaryOperator updateFunction) {
        long offset = checkedByteOffset(i);
        int prev, next;
        do {
            prev = getRaw(offset);
            next = updateFunction.applyAsInt(prev);
        } while (!compareAndSetRaw(offset, prev, next));
        return next;
    }

    /**
     * 使用对当前值和给定值应用给定函数的结果自动更新索引i处的元素，并返回前一个值。
     * 该函数应该没有副作用，因为当尝试更新由于线程之间的争用而失败时，可以重新应用它。
     * 该函数应用索引i处的当前值作为第一个参数，并将给定的更新作为第二个参数。
     */
    public final int getAndAccumulate(int i, int x,
                                      IntBinaryOperator accumulatorFunction) {
        long offset = checkedByteOffset(i);
        int prev, next;
        do {
            prev = getRaw(offset);
            next = accumulatorFunction.applyAsInt(prev, x);
        } while (!compareAndSetRaw(offset, prev, next));
        return prev;
    }

    /**
     * 使用对当前值和给定值应用给定函数的结果自动更新索引i处的元素，并返回更新后的值。
     * 该函数应该没有副作用，因为当尝试更新由于线程之间的争用而失败时，可以重新应用它。
     * 该函数应用索引i处的当前值作为第一个参数，并将给定的更新作为第二个参数。
     */
    public final int accumulateAndGet(int i, int x,
                                      IntBinaryOperator accumulatorFunction) {
        long offset = checkedByteOffset(i);
        int prev, next;
        do {
            prev = getRaw(offset);
            next = accumulatorFunction.applyAsInt(prev, x);
        } while (!compareAndSetRaw(offset, prev, next));
        return next;
    }

    /**
     * 返回数组当前值的字符串表示形式。
     */
    public String toString() {
        int iMax = array.length - 1;
        if (iMax == -1)
            return "[]";

        StringBuilder b = new StringBuilder();
        b.append('[');
        for (int i = 0; ; i++) {
            b.append(getRaw(byteOffset(i)));
            if (i == iMax)
                return b.append(']').toString();
            b.append(',').append(' ');
        }
    }

}
